sorter: Some doc corrections
authorMatthias Clasen <mclasen@redhat.com>
Sun, 28 Jun 2020 16:39:48 +0000 (12:39 -0400)
committerMatthias Clasen <mclasen@redhat.com>
Sun, 28 Jun 2020 16:43:11 +0000 (12:43 -0400)
The docs were referring to some non-existing enum value.
Fix things up to match the current code.

gtk/gtksorter.h

index 5a997a7c841f1218983211442a5535641a36d89b..9dc78f20db8f95df7b04fd952dcb5f1863386143 100644 (file)
@@ -31,12 +31,9 @@ G_BEGIN_DECLS
 
 /**
  * GtkSorterOrder:
- * @GTK_SORTER_ORDER_PARTIAL: A partial order. And #GtkOrdering is possible.
- * @GTK_SORTER_ORDER_INVALID: An invalid order. gtk_sorter_compare() will
- *     always return %GTK_ORDERING_INVALID if both items are unequal.
+ * @GTK_SORTER_ORDER_PARTIAL: A partial order. Any #GtkOrdering is possible.
  * @GTK_SORTER_ORDER_NONE: No order, all elements are considered equal.
- *     gtk_sorter_compare() will only return %GTK_ORDERING_EQUAL or
- *     %GTK_ORDERING_INVALID.
+ *     gtk_sorter_compare() will only return %GTK_ORDERING_EQUAL.
  * @GTK_SORTER_ORDER_TOTAL: A total order. gtk_sorter_compare() will only
  *     return %GTK_ORDERING_EQUAL if an item is compared with itself. Two
  *     different items will never cause this value to be returned.